User

interface User

A user holds the user's metadata and tokens for accessing App Services and Device Sync functionality.

The user is used to configure synchronized realms with SyncConfiguration.Builder.

Types

State

A user's potential states.

delete

abstract suspend fun delete()

Permanently deletes this user from your Atlas App Services app.

equals

abstract operator override fun equals(other: Any?): Boolean

Two Users are considered equal if they have the same user identity and are associated with the same app.

linkCredentials

abstract suspend fun linkCredentials(credentials: Credentials): User

Links the current user with a new user identity represented by the given credentials.

logOut

abstract suspend fun logOut()

Log the user out of the Realm App.

remove

abstract suspend fun remove(): User

Removes the user and any Realms the user has from the device.

app

abstract val app: App

The App this user is associated with.

abstract val id: String

The server id of the user.

identities

Returns a list of the user's identities as defined by the authentication providers enabled for this user.

identity

abstract val identity: String

The server id of the user.

loggedIn

Returns whether or not this user is still logged into the App Services Application.

state

The State this user is in.